Powered by Gatsby
Starting from v2, Docz is entirely built using GatsbyJS. It's optimised for a lightning fast development experience and speedy build times. This also allows you to leverage GatsbyJS's huge ecosystem of plugins and tools.
Zero config
No need to worry about complex configuration settings to build and run your documentation. With Docz you can create customizable sites with a single command.
Easy to customize
Using component shadowing you can create your own theme or customize the provided theme to make your documentation website stand out.
Based on MDX
MDX is Markdown + JSX, it brings the world of components to Markdown. MDX makes it possible to import and use your components in Markdown-style files. Docz fully leverages this, and provides many built-in components that augment and speed up your documentation workflow.
Fully pluggable
Plugins provide a great way to add functionality to your application without changing your code. With Docz, you can hook into the dataflow and build steps of your application using GatsbyJS and Docz plugins.
TypeScript support
Docz provides native TypeScript support for TSX components and can generate documentation from your prop types and comments in your code. All exported Docz components are built using TypeScript. Check out the API section for more information.
How to
Install Docz as a dependency
$ yarn add docz react react-dom --dev
Create an .mdx file anywhere in your project
--- name: Button route: / --- import { Playground, Props } from 'docz' import { Button } from './' # Button <Props of={Button} /> ## Basic usage <Playground> <Button>Click me</Button> <Button kind="secondary">Click me</Button> </Playground>
That's it, your docs are ready to go !
$ yarn docz devMore Info